tolua是一个Unity静态绑定lua代码的解决方案，它能够反射分析C#代码，生成C#包装类。它大大简化了C#代码和lua代码之间的集成，可以自动生成用于在Lua中访问Unity的绑定代码，并把C#中的常量、变量、函数、属性、类以及枚举暴露给Lua。简单来说就是tolua实现了一套方案，通过这个方案我们可以透明地在lua层调用C#的函数，也可以反过来从C#端调用lua的函数。这个项目是开源的，它的源代码部署在GitHub上：

tolua

tolua_runtime

这里有两个项目，是因为解决方案除了需要在C#端实现逻辑以外，还需要修改lua虚拟机，在C层扩展lua虚拟机的接口，完成C#对象的管理，以及接口的转发。那么，实际使用过程中，一般项目的业务代码架构如下图所示：

这里，tolua在大多数平台上使用的lua虚拟机并非是官方lua，而是LuaJIT，目前只支持lua5.1的语法。当然我们也可以对源码进行修改，替换lua虚拟机为官方lua的高版本。从图中也可以看出，tolua runtime是非常重要的中间层，它扩展了lua虚拟机，让lua和C#的交互畅通无阻。

我们来看一下官方给的第一个例子HelloWorld，这个例子很简单，就是演示了如何在C#端执行一段lua代码：

这段代码中，第9-10行是用来初始化tolua本身的，这里的LuaState数据结构表示lua虚拟机；第11-16行就是加载一段代码并执行，DoString函数与lua自带的loadstring函数功能类似，第一个参数是要执行的lua代码块字符串，第二个参数是代码块的名称chunkName，该参数主要用于调试。第17行的CheckTop函数用来检查当前lua虚拟机的栈顶状态，如果栈中还有元素残留，说明虚拟机出现了问题，很可能是某个自定义扩展lua的函数所导致。第18-19行是对LuaState数据结构进行销毁清理。

tolua的GitHub上也附带了Unity工程，我们尝试运行下HelloWorld这个例子，可以看到输出如下：

控制台打印了初始化lua虚拟机的时间，以及LuaJIT的版本号和状态，操作系统的信息，还有我们执行的lua代码，最后是lua虚拟机销毁的log。

有了大概的了解之后，我们现在深入地去看初始化相关的两个函数。首先是LuaState的构造函数，长这样：

从这些函数的名字来推断，LuaState的构造过程大致可以分为以下几个部分：

那么现在我们来说一下这个traits。熟悉C++的同学肯定会立马想到type_traits，是的，这里这两个函数的作用与之类似，通过C#的泛型，在编译期就完成了不同类型检查函数，转换函数的绑定。

TypeTraits和StackTraits都是泛型类，来看一下它们的Init函数：

从函数实现可以了解到，如果某个类型没有调用Init函数进行初始化，那么这两个泛型类会为该类型提供默认的函数。这个感觉是不是有点像C++的类模板？某些特定的类型，需要对类模板进行特化/偏特化处理，只不过C#要灵活得多。通过这种方式，我们就可以直接在外部根据不同类型，动态地增加/删除/修改对应绑定的函数，极大增加了代码的灵活性。

观察TypeTraits的Init实现，可以知道它的Check函数是一个接受两个参数（IntPtr，int），返回类型为bool的函数。我们来看一下int类型对应的CheckNumber函数：

这个函数很简单，就是判断lua栈上pos位置的元素类型是否为number。由于lua没有像C#那样提供那么多种数值类型，因此我们看到有很多C#数值类型的Init使用的是CheckNumber。那么不妨让我们大胆地猜测一下，TypeTraits的Check函数是用来判断lua栈上pos位置的元素类型是否为T。

类似地，可以知道StackTraits拥有3个函数，其中Push函数接受两个参数（IntPtr，T），返回类型为void；Check函数接受两个参数（IntPtr，int），返回类型为T；To函数接受两个参数（IntPtr，int），返回类型为T。同样我们看一下int类型对应的处理：

那么，大胆地猜测，StackTraits的Push函数是用来把类型T的元素压入lua栈中；Check函数对栈上pos位置的元素进行检查，并尝试转换为T类型的值返回，可能会抛出异常；To函数对栈上pos位置的元素直接进行类型转换，返回T类型的值，不会抛出异常，如果转换失败返回T类型的默认值。

下一步就是创建lua虚拟机了，这块没有什么好说的，直接调用luaL_newstate即可。

接下来是这一句LuaException.Init(L);，它做的事情比较简单，就是为LuaException类指定了当前项目的路径，这个类顾名思义，是用来处理lua异常堆栈用的。

然后就到了重头戏，加载各种lua库的代码了。首先是OpenToLuaLibs，定义如下：

tolua_openlibs是一个C函数，它的实现可以在tolua_runtime这里找到，位于tolua.c文件中。这里提一下，tolua.c基本上放了所有对lua虚拟机进行扩展的函数，主要是用在和unity，也就是C#层交互中。

我们先来看一下函数的声明。LUALIB_API是一个宏，在不同的编译环境下定义不同：

函数的返回类型为void，说明该函数返回时，不会在lua虚拟机栈上存放任何值。这也是函数实现中，一开始调用lua_gettop记录栈顶，然后最后调用lua_settop恢复栈顶的原因。函数相对来说比较长，大概可以分为以下几个部分：

luaL_openlibs就是加载lua自带的各种C库函数，对于tolua默认使用的LuaJIT来说，有如下这些：

初始化tolua环境这一部分比较复杂，我们一个函数一个函数地过。首先是tolua_setluabaseridx函数：

package.loaders主要用在lua的require函数中，它会使用loaders里的load函数加载指定模块。函数第7-13行的主要作用就是将C#层自定义的Loader函数插入到原有的package.loaders的第2个位置中。这个函数接管了lua文件加载的逻辑，可以方便我们使用项目自身加载文件的方式来管理lua文件。可能有人会问，为什么不是插入到表头呢？答案是第1个位置的lua loader叫做preload，它使用package.preload这个内部table，这个table的key是加载模块的名称，value是加载函数。也就是说，它是一种更特殊的loader，会根据模块名而启动特殊的加载逻辑。那当然C#的Loader函数要为它让步啦。

这里也贴一下官方的解释：

OpenLibs里的剩下几个函数，这里就不一一展开了，第4-10行主要就是用C#重写了lua自带的panic，print，dofile，loadfile函数，重写它们的原因也是为了能够在C#层获得详细的日志和堆栈，以及可以在C#层控制lua的加载逻辑；第12-28行就是新增了tolua.isnull，tolua.typeof，tolua.tolstring，tolua.toarray一些辅助函数。再看第30-37行，我们先不用管这些函数调用的具体含义，最后的结果就是在lua层定义了一个tolua.null和null两个全局变量，这两个变量指向同一个userdata，这个userdata的含义就是C#的NullObject类。这个类是tolua自己定义的，就是一个空空如也的类，用来标记空对象：

好了，现在可以回到LuaState的构造函数继续分析了。接下来看到的是OpenBaseLibs函数，这个函数实际上就是将常用的C#类注册到lua中，使得lua可以访问C#类的方法或属性，这个后面会展开来说；LuaSetTop(0)所做的事情就是清理当前lua虚拟机的堆栈，使其保持调用前的模样；InitLuaPath函数就是设置了加载lua文件的路径，也就是扩充了lua的package.path。

自此，包含tolua环境的lua虚拟机算是构造完成了。剩下的就是一个Start函数。这个函数中我们目前只需关注OpenBaseLuaLibs：

可以看到这里又去加载了一个lua文件，不难发现，这个lua文件对一些可能会频繁调用，但又实现简单的C#方法，以及一些常用的值类型，改用lua实现了：

LuaUnityLibs.OpenLuaLibs分为两步，第一步的tolua_openlualibs对lua实现的C#方法和类型，进行了注册，这样做的目的是使得lua和C#互相调用时，这些方法和类型会自动转换。例如C#传入一个C#版本的Vector3给lua时，lua层接收到的实际上是lua版本的Vector3，而不是一个userdata；第二步的SetOutMethods为这些类型设置了out方法，可以让lua层调用C#层的带有out参数的方法。

自此，tolua的初始化流程算是被我们拆解完毕了。总结来说，初始化主要分为两大块内容，一是进行各种配置，例如修改了若干原生lua方法，缓存了各种变量，创建了tolua所需的各种数据；二是加载了各种tolua用的库，这些库既可能来自C，也可能来自C#，甚至从lua频繁调用的角度考虑，来自lua。

下一节我们将关注C#如何调用lua函数的实现机制。

如果你觉得我的文章有帮助，欢迎关注我的微信公众号 我是真的想做游戏啊

[1] Lua 5.1 Reference Manual

[2] The LuaJIT Project

[3] tolua

[4] tolua_runtime

[5] Lua的require小结

[6] 再探Lua的require